Velostrata REST API

The Velsotrata API allows for automation and integration with third-party applications, specifically with common orchestration tools, e.g. VMware vRA, Ansible.

The API is served by a REST Web service, protected with basic HTTP authentication.

REST URL structure - https://<host>/velostrata/api/v40/

API input and output objects are serialized in JSON format.

More information: http://velostrata.com

Contact Info: support@velostrata.com

Version: 4.0

BasePath: "/velostrata/api/v40"

Cloud Extensions Operations
	post /cloudextensions/{cloudExtensionId}/operations/cloneVm	Clone VM To Cloud
	post /cloudextensions	Create Cloud Extension
	delete /cloudextensions/{cloudExtensionId}	Delete Cloud Extension
	get /cloudextensions/{cloudExtensionId}	Describe Cloud Extension
	get /cloudextensions/{cloudExtensionId}/securitygroups	Describe Security Groups
	get /cloudextensions/{cloudExtensionId}/allowedtasks	Lists allowed tasks
	get /cloudextensions/{cloudExtensionId}/subnets	Describe Subnets
	post /cloudextensions/{cloudExtensionId}/operations/offlineMigrateVmToCloud	Offline Migration.
	post /cloudextensions/{cloudExtensionId}/operations/fullMigrateVm	Fully Migrate VM To Cloud
	get /cloudextensions/{cloudExtensionId}/cloud/aws/encryptionkey	Get AWS Encryption Key
	get /cloudextensions/{cloudExtensionId}/cloud/aws/instancetypes	Get AWS Instance Types
	get /cloudextensions	List Cloud Extensions
	post /cloudextensions/{cloudExtensionId}/operations/moveVm	Move VM To Cloud
	post /cloudextensions/{cloudExtensionId}/operations/reconfigure	Reconfigure Cloud Extension
	post /cloudextensions/{cloudExtensionId}/operations/repair	Repair Cloud Extension
	post /cloudextensions/{cloudExtensionId}/operations/start	Start Cloud Extension
	post /cloudextensions/{cloudExtensionId}/operations/stop	Stop Cloud Extension
	post /cloudextensions/{cloudExtensionId}/operations/upgrade	Upgrade Cloud Extension

Cloud Operations
	get /cloud/aws/encryptionkeys	List AWS Encryption Keys
	get /cloud/aws/roles	List AWS IAM Roles
	get /cloud/aws/regions{regiodId}instances	List AWS Instances
	get /cloud/aws/regions	List AWS Regions
	get /cloud/aws/securitygroups	List AWS Security Groups
	get /cloud/aws/storagetypes	List AWS Storage Types
	get /cloud/aws/subnets	List AWS Subnets
	get /cloud/aws/vpcs	List AWS VPCs
	get /cloud/gcp/regions	List GCP Regions
	get /cloud/gcp/subnets	List GCP Subnetworks
	get /cloud/gcp/networks	List GCP Networks
	get /cloud/gcp/suggestedname	Suggest valid name for the VM
	get /cloudextensions/{cloudExtensionId}/cloud/gcp/machinetypes	List GCP Machine Types
	get /cloud/gcp/zones	List GCP Zones
	get /cloud/gcp/serviceaccounts	List GCP Service Accounts
	get /cloud/gcp/projects	List GCP Projects
	get /cloud/gcp/suggestedname	Suggest a valid name for the VM
	get /cloud/gcp/projects	List GCP Projects
	get /cloud/gcp/suggestedname	Suggest a valid name for the VM

Cloud Credentials Operations
	delete /cloud/credentials/{credName}	Delete Credentials
	get /cloud/credentials/{credName}	Describe Credentials
	get /cloud/credentials	List Credentials
	put /cloud/credentials/{credName}	Save Credentials

Cloud Details Operations
	delete /cloud/details/{detailsName}	Delete Cloud Details
	get /cloud/details/{detailsName}	Describe Cloud Details
	get /cloud/details	List Cloud Details
	post /cloud/details	Save Cloud Details

Management Operations
	post /mgmt/downloadupgradepackage	Download Management Upgrade Package
	post /mgmt/upgrade	Upgrade Management
	get /mgmt/createcertificate	Generate Certificate

Tasks Operations
	delete /tasks/{taskId}	Cancel Task
	get /tasks/{taskId}	Describe Task
	get /tasks	List Active Tasks
	post /tasks	List Tasks

Virtual Machine Operations
	post /vms/{vmId}/operations/canceldetach	Cancel Detach
	post /vms/{vmId}/operations/cleanup	Cleanup VM
	post /vms/{vmId}/operations/deleteclone	Delete Clone
	get /vms/{vmId}	Describe Managed VM
	post /vms/{vmId}/operations/detach	Detach
	post /vms	Find Managed VMs
	get /vms/{vmId}/allowedTasks	List Allowed Tasks
	get /vms/{vmId}/console	Get Cloud Console Text
	get /vms/{vmId}/screen	Get Cloud Screen Image
	get /vms/{vmId}/instancetypes	Get Available Instance Types For VM
	get /vms	List Managed VMs
	post /vms/{vmId}/operations/migrate	Migrate
	post /vms/{vmId}/operations/preparetodetach	Prepare To Detach
	post /vms/{vmId}/operations/probe	Probe
	post /vms/{vmId}/operations/reboot	Reboot
	post /vms/{vmId}/operations/reconfigure	Reconfigure
	post /vms/{vmId}/operations/return	Return From Cloud
	post /vms/{vmId}/operations/start	Start
	post /vms/{vmId}/operations/stop	Stop

Recommendations
	get /recommendations/operations/listMonitoring	Get monitored VM list
	post /recommendations	Get VM sizing recommendations
	post /recommendations/operations/startMonitoring	Start monitor usage for VMs
	post /recommendations/operations/stopMonitoring	Stop monitor usage for VMs

About
	get /about	About the product

Migration Waves

The Velostrata Migration Waves API allows for automation and integration with third-party tools

The API supports Waves managements, jobs on Waves, and monitoring of jobs.

Runbook Operations
	post /runbooks	Generate an initial Runbook in CSV format from on-prem Data Center or AWS cloud

Right-Sizing
	post /waves/{name}/recommendations	Start Wave monitoring
	delete waves/{name}/recommendations	Stop Wave monitoring
	get waves/{name}/recommendations	Retrieve Wave size recommendations

Wave Operations
	get /waves	List all Waves in the system
	put /waves/{name}	Create a new Wave
	get /waves/{name}	Describe Wave
	delete /waves/{name}	Delete Wave
	post /waves/{name}	Initiate a new Wave job with a specific action (e.g FullMigration)
	get /waves/{name}/csv	Retrieve Wave CSV
	get /waves/{name}/vms	Retrieve Wave VMs
	post /waves/{name}/validations	Start Wave validation
	delete /waves/{name}/validations	Abort Wave validation
	get /waves/{name}/validations	Retrieve Wave validation failures
	get /waves/{name}/allowedOperations	Retrieve Wave allowed operations

Job Operations
	get /runs	List of all Waves jobs in the system
	get /runs/{name}	Describe a Wave job
	delete /runs/{name}	Abort a Wave Job
	get /runs/{name}/vms	List Wave job VMs

VM Operations
	get /vms	Retrieve VMs that are not part of a Wave